Delivery Report
A delivery report contains the status and state of each message sent through the Sinch India WhatsApp API.
The default format of a delivery report is as mentioned below:
Name | Description | JSON Type |
---|---|---|
del_status | The status of the message. It can be delivered, read, sent or failed. | String |
del_time | ISO-8601 datetime of the status update. | String |
rqst_ack_id | The acknowledgment of the message created by meta. | String |
messageId | Unique id of each message provided by enterprise or autogenerated by Sinch India. | String |
Status callback with state 'sent'
Payload
{
"rqst_ack_id": "1XXXXXXXXXXXXXXXX",
"del_time": "2X/0X/2XXX 1X:0X:0X",
"mobile_no": "9XXXXXXXXXXX",
"messageId": "Abcd-1XXXXXXXXXXXX-7XXX-0XXX",
"del_status": "sent"
}
Status callback with state 'delivered'
Payload
{
"rqst_ack_id": "1XXXXXXXXXXXXXXXX",
"del_time": "2X/0X/2XXX 1X:0X:0X",
"mobile_no": "9XXXXXXXXXXX",
"messageId": "Abcd-1XXXXXXXXXXXX-7XXX-0XXX",
"del_status": "delivered"
}
Status callback with state 'read'
Payload
{
"rqst_ack_id": "1XXXXXXXXXXXXXXXX",
"del_time": "2X/0X/2XXX 1X:0X:0X",
"mobile_no": "9XXXXXXXXXXX",
"messageId": "Abcd-1XXXXXXXXXXXX-7XXX-0XXX",
"del_status": "read"
}
Status callback with state 'failed'
Payload
{
"rqst_ack_id": "1XXXXXXXXXXXXXXXX",
"del_time": "2X/0X/2XXX 1X:0X:0X",
"mobile_no": "9XXXXXXXXXXX",
"messageId": "Abcd-1XXXXXXXXXXXX-7XXX-0XXX",
"del_status": "failed",
"del_desc": "<Message Failure Reason>"
}
Note: The 'del_desc' is only available for the messages with 'failed' status, in order to provide the failure reason.
Enterprise can also configure his custom format for a delivery report at SmartTA.
Success DLRs
S.No | Description | Reason |
---|---|---|
1 | Sent | Message sent to user but yet to be delivered. |
2 | Delivered | Message delivered but yet to be read by customer. Message will reflect as delivered if customer has marked the read receipts as off. |
3 | Read | Delivered message is read by customer. |
Failure Codes
Error Description | Error Code |
---|---|
MISSING MOBILE NUMBER AND WA ID | -6 |
OPTIN BLOCKED | 24 |
INVALID ENCRYPTED DATA | 26 |
REQUIRED PARAMETER IS MISSING | 1008 |